Vcenter Vcha IpSpec

Vcenter Vcha IpSpec

The Vcenter Vcha IpSpec schema contains IP information used to configure a network interface.

This schema was added in vSphere API 6.7.1.

JSON Example

{
    "ip_family": "string",
    "ipv4": {
        "address": "string",
        "subnet_mask": "string",
        "prefix": 0
    },
    "ipv6": {
        "address": "string",
        "prefix": 0
    },
    "default_gateway": "string",
    "dns_servers": [
        "string"
    ]
}

string

ip_family

Required

Family of the IP address to configure the interface.

For more information see: Vcenter Vcha IpFamily.

This property was added in vSphere API 6.7.1.

ipv4

Optional

If the family of the ip is IPV4, then this will point to IPv4 address specification.

This property was added in vSphere API 6.7.1.

This property is optional and it is only relevant when the value of ip_family is Vcenter Vcha IpFamily.IP_v4.

ipv6

Optional

If the family of the ip is IPV6, then this will point to IPv6 address specification.

This property was added in vSphere API 6.7.1.

This property is optional and it is only relevant when the value of ip_family is Vcenter Vcha IpFamily.IP_v6.

string

default_gateway

Optional

The IP address of the Gateway for this interface.

This property was added in vSphere API 6.7.1.

If missing or null, gateway will not be used for the network interface.

array of string

dns_servers

Optional

The list of IP addresses of the DNS servers for this interface. This list is a comma separated list.

This property was added in vSphere API 6.7.1.

If missing or null, DNS servers will not be used for the network interface.